Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Instant Search: Include a8c-support-theme kb_article taxonomies #38660

Open
wants to merge 7 commits into
base: trunk
Choose a base branch
from
Open

Instant Search: Include a8c-support-theme kb_article taxonomies #38660

wants to merge 7 commits into from

Conversation

nickpagz
Copy link

@nickpagz nickpagz commented Jul 31, 2024 •
edited
Loading

Proposed changes:

  • This PR extends Instant Search to include taxonomies which are part the a8c-support-theme.
  • The a8c-support-theme is the parent to the child themes used on A4A support site, and the upcoming refresh of the Pocket Casts support site.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

https://github.com/a8cteam51/a8c-support-theme/issues/27

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

I'm not completely sure how to test this change, but ideally:

  • Create/visit a site using the a8c-support-theme.
  • Add and setup Jetpack Instant Search so it includes results from the kb_articles CPT, including the filter options in the widget.
  • On the front-end, try a new search. The filters available should include relevant entries for the kb_category and kb_tag taxonomies.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 31, 2024 •
edited
Loading

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/class-search-taxonomies-kb-article branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/class-search-taxonomies-kb-article

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/class-search-taxonomies-kb-article

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 31, 2024 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • 🔴 Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for September 10, 2024 (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Backup plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Boost plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Search plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Social plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Starter Plugin plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Protect plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Videopress plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Migration plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen daily.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Wpcomsh plugin:

  • Next scheduled release: on demand (usually Mondays if not sooner).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Automattic For agencies client plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added [Plugin] Automattic For Agencies Client [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh labels Aug 2, 2024
@nickpagz
Copy link
Author

nickpagz commented Aug 2, 2024

My first Jetpack PR, go easy!
I'm not sure how feasible it is to properly test this change. If needed, any suggestions would be welcomed!

@nickpagz nickpagz added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Aug 2, 2024
trakos
trakos previously approved these changes Aug 19, 2024
View reviewed changes
@anomiex anomiex added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Aug 27, 2024
@anomiex
Copy link
Contributor

anomiex commented Aug 27, 2024

Needs a trunk merge now.

@nickpagz
Copy link
Author

I'm struggling to get this branch updated. I expected a basic fetch -> merge -> commit -> push, but local commit phpcs checks run out of memory, and several lock files show as needing an update and it's not clear how these should be done.
Some direction would be appreciated, thanks!

@anomiex
Copy link
Contributor

anomiex commented Aug 28, 2024

Looking at the message from the "Lock files are up to date" check, it seems you committed the merge conflict markers to the files instead of resolving the conflicts, e.g.

jetpack/projects/plugins/automattic-for-agencies-client/composer.lock

Lines 865 to 869 in 2764fbb

<<<<<<< HEAD
"reference": "5d71e613ed54856799d620de9336ba8dfe795382"
=======
"reference": "64ed9303f16e3377d99091c67842f3c4b07b71eb"
>>>>>>> origin/trunk

The doc at docs/git-workflow.md#dealing-with-lock-files has some tips on how to most easily resolve merge conflicts in lock files. TL;DR: reset them to the trunk versions then run tools/composer-update-monorepo.sh on each one's containing directory.

I don't know what to tell you about phpcs running out of memory when run locally, other than to check that you don't have an unnecessarily low memory_limit set for php cli processes. php -r 'var_dump( ini_get( "memory_limit" ) );' may help you check that; a setting of -1 means no limit. If you need to change it, you might try using php -i to find where the ini files are being loaded from and adjust them.

@nickpagz
Copy link
Author

Thanks for the tips! I'll try with these and see if I can get it to update properly.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 9, 2024

This PR has been marked as stale. This happened because:

  • It has been inactive for the past 3 months.
  • It hasn’t been labeled `[Pri] BLOCKER`, `[Pri] High`, etc.

If this PR is still useful, please do a [trunk merge or rebase](https://github.com/Automattic/jetpack/blob/trunk/docs/git-workflow.md#keeping-your-branch-up-to-date) and otherwise make sure it's up to date and has clear testing instructions. You may also want to ping possible reviewers in case they've forgotten about it. Please close this PR if you think it's not valid anymore — if you do, please add a brief explanation.

If the PR is not updated (or at least commented on) in another month, it will be automatically closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trakos trakos trakos left review comments

Assignees

@nickpagz nickpagz

Labels
[Package] Sync [Plugin] Automattic For Agencies Client [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nickpagz @anomiex @trakos @coder-karen